docs: document agentic provisioning deep-link path parameter#17322
Merged
Conversation
The deep_links endpoint now takes an optional `path` to land a provisioned user on any in-app page after login (replacing the fixed `purpose` enum). Update the Provisioning API doc: request fields, example, validation, the `invalid_path` error, the sequence diagram, and the Node helper. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 0 errors, 15 warnings, 13 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 8:140 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 14:15 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 42:71 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 42:76 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 98:144 | warning | 'org's' is a possible misspelling. | PostHogBase.Spelling |
| 124:5 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 130:50 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 130:145 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 173:26 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 189:1 | suggestion | Address the reader directly. Use 'you' instead of 'The user'. | PostHogDocs.DirectAddress |
| 203:42 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 270:44 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 332:228 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 332:233 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 344:224 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 350:50 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 365:199 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 427:28 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 428:30 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 439:9 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 441:35 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 444:32 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 451:14 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 463:38 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 489:18 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 501:20 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 622:74 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 622:177 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
The agentic provisioning
deep_linksendpoint now accepts an optionalpathto land a provisioned user on any in-app page after login, replacing the old fixedpurposeenum (now just a free-form analytics label). This updates the Provisioning API doc:pathrequest field with a real example, and demotespurposeto the analytics label it now is//, backslashes,javascript:, control characters, whitespace)invalid_path(400) error codegetDeepLinkUrlhelper to take an optionalpathShipped in PostHog/posthog#60740. Facts verified against the merged code.
Checklist
vercel.json(n/a — no page moved)Agent-authored (Claude Code); requires human review before merge.